home *** CD-ROM | disk | FTP | other *** search
/ develop, the CD; issue 1 / Apple_Develop_1989.bin / Declaration ROM / ExROM1Fun.a next >
Text File  |  1989-09-15  |  11KB  |  282 lines
  1. ;---------------------------------------------------------------------------------------
  2. ;
  3. ;File:          ExROM1Fun.a
  4. ;Dev system:    MPW 3.0
  5. ;By:            MacDTS
  6. ;Date:            8/08/89
  7. ;
  8. ; This is a very small sample declaration ROM with the required board 
  9. ; sResource and a functional sResource (which is blank).
  10. ; The board id and functional sResource types are especially bogus - your values
  11. ; must be obtained from MacDTS, after sending in the required information.
  12. ; Anyway, this file shows how to put together a ROM.  You also need
  13. ; the Cards and Drivers book, with the source code for a ROM and driver.
  14. ; Both are stripped down versions of the Apple Macintosh Video card ROM and
  15. ; video driver aka the TFB board.  There are also other examples and exploded
  16. ; drawings of declaration ROMs on the Developer Helper CD. Volume one is 
  17. ; known as "Phil and Dave's Excellent CD".  The examples, tools, and drawings are 
  18. ; also on AppleLink.  To get to them, go into (in order):
  19. ;
  20. ;  Developer Services bulletin board icon
  21. ;     Developer Technical Support folder 
  22. ;        Macintosh folder 
  23. ;           Tools folder
  24. ;             Card Dev tools folder
  25. ;
  26. ;
  27. ; In the Card Dev Tools folder are other folders containing tools and 
  28. ; libraries.  These include:
  29. ;
  30. ; Examples folder            - contains example declaration ROMs, video driver, 
  31. ;                              source to a program like the GetsInfo program found
  32. ;                              in the Slot Tools folder
  33. ; Gamma Information folder    - contains documention discussing gamma table format. 
  34. ;                              This will be updated in later documentation for the 
  35. ;                              new 32-bit QuickDraw.  Eventually, the Cards and 
  36. ;                              Drivers book will contain the new gamma information, 
  37. ; NuBusTester folder        - contains a library to detect new ROMs with fixed 
  38. ;                              Slot Manager (Slot Manager that runs in 32-bit mode
  39. ;                              as opposed to 24-bit mode)
  40. ; Training Tools folder        - contains MacDraw drawings of exploded
  41. ;                              configuration ROMs (like the existing Apple video
  42. ;                              card ROM and the Apple EtherNet board ROM.
  43. ;                           
  44. ; Slot tools folder            - Inside, you'll find these tools:
  45. ;
  46. ;                              CRCPatch - MPW tool that calculates and patches in 
  47. ;                              the crc value of the assembled Declaration ROM file.
  48. ;
  49. ;                              Data - MPW tool takes the assembled file and strips 
  50. ;                              off the code 0 segment,leaving the code 1 segment 
  51. ;                              (the raw code).  The resulting file can then be 
  52. ;                              downloaded to a rom burning machine. 
  53. ;                            
  54. ;                              Tjscomm - A small terminal program that can be used
  55. ;                              to download the data file to a rom burning machine.
  56. ;                            
  57. ;                              SlotMgrTst - application that excersises the slot 
  58. ;                              manager by making slot manager calls
  59. ;                            
  60. ;                              GetsInfo - application that displays sResources and
  61. ;                              other configuration ROM information
  62. ;
  63. ; Disclaimer: the above may be reorganized at any time, or changed via additions 
  64. ; and deletions.
  65. ;
  66. ;
  67. ;  The general structure of this example ROM is:
  68. ;
  69. ;                        [Format/Header]
  70. ;                                |
  71. ;                                |
  72. ;                      [sResource Directory]
  73. ;                            /        \
  74. ;                           /         \
  75. ;                          /              \
  76. ;                         /               \
  77. ;            [Board sResource]        [Functional sResource]
  78. ;                - Primary Init.            - Driver Directory.
  79. ;                - board id
  80. ;                - Vendor Info.            
  81. ;
  82. ;
  83. ;  If you want to print this, I suggest using landscape mode!!!
  84. ;
  85. ;-------------------------------------------------------------------
  86.  
  87.             MACHINE        MC68020
  88.  
  89. ;=====================================================================
  90. ;    Initial Assembler Directives
  91. ;=====================================================================
  92.                 PRINT    OFF
  93.                 STRING     C
  94.                                                     ;Note - File names changed
  95.                                                     ;since example in C & D 
  96.                                                     ;book was published.
  97.                 INCLUDE    'SysErr.a'                    ;Macintosh error equates
  98.                 INCLUDE    'SysEqu.a'                    ;Macintosh System equates
  99.                 INCLUDE    'ROMEqu.a'                    ;Declaration ROM equates
  100.                 INCLUDE    'SlotEqu.a'                    ;Slot Manager equates and macros
  101.                 INCLUDE    'TimeEqu.a'                    ;Macintosh traps
  102.                 INCLUDE    'Traps.a'                    ;Macintosh traps
  103.                 PRINT    ON
  104.  
  105. ; 
  106. ;=====================================================================
  107. ;    BEGIN Declaration ROM
  108. ;=====================================================================
  109. SampleDeclROM    MAIN
  110.  
  111.                 
  112.  
  113. ;*************************************************************
  114. ;        Constants
  115. ;*************************************************************
  116.   
  117. ROMSize            EQU        $1000                        ;4K byte ROM in this example
  118. TheBoardId        EQU        $ABCD                        ;the Board Id (DON'T USE
  119.                                                     ; THIS-GET from DTS!)
  120.  
  121.                                                     ;board sResource equates
  122.                                                     ;the following two lines are 
  123. ;catBoard        EQU         1                        ;commented out since the equates
  124. ;TypeBoard        EQU         0                        ;are already defined in ROMEqu.a
  125. DrSwBoard        EQU         0                        ;NOT in ROMEqu.a, define it here
  126. DrHwBoard        EQU         0                        ;NOT in ROMEqu.a, define it here
  127.  
  128. CatExCat        EQU         $6666                    ;Functional sResource sRsrc_Type
  129. TypExTyp        EQU         $7777                    ;equates. THESE ARE EXAMPLES
  130. DrSwExSw        EQU         $8888                    ;ONLY!  DON'T USE THESE VALUES
  131. DrHwExHw        EQU         $9999                    ;GET THEM FROM DTS!!
  132.  
  133.                                                     ;Example values-vendors
  134.                                                     ;should modify as needed
  135. defMinorBase    EQU    0                                ;RAM Offset is 0
  136. defMinorLength    EQU    $40000                            ;RAM length is $40000
  137.  
  138. ;-----------  sResource Directory                    ;<Id OF>
  139. sRsrcBoard        EQU        1                            ;Board sResource {May be any 
  140.                                                     ;number in [0..127]}
  141. sRsrcFun        EQU        128                            ;functional sResource {May be 
  142.                                                     ;any number in [128..254]}
  143.  
  144.                                                             
  145. ;=====================================================================
  146. ;        Directory 
  147. ;=====================================================================
  148. _sRsrcDir        OSLstEntry    sRsrcBoard,_sRsrcBoard    ;References board sResource.
  149.                 OSLstEntry    sRsrcFun,_sRsrcFun        ;References functional sResource.
  150.                 DatLstEntry    endOfList,0                ;End of the list.
  151.  
  152.                                                             
  153. ;=============================================================
  154. ;            The Board sResource
  155. ;=============================================================
  156. _sRsrcBoard        OSLstEntry    sRsrcType,_BoardType    ;References Rsrc_Type entry
  157.                 OSLstEntry    sRsrcName,_BoardName    ;References Rsrc_Name entry
  158.                 DatLstEntry    boardId,TheBoardId        ;boardId  **ASSIGNED BY MACDTS**
  159.                 OSLstEntry    primaryInit,_sPInitRec    ;References Primary init record.
  160.                 OSLstEntry    vendorInfo,_VendorInfo    ;References Vendor info list.
  161.                 DatLstEntry    endOfList,0                ;End of the list.
  162.  
  163.                                                     ;Rsrc_Type IS ALWAYS THE SAME
  164.                                                     ;for the board sResource 
  165.                                                     ;(but varies with different
  166.                                                     ;functional sResources)
  167. _BoardType        DC.W    CatBoard                    ;ALWAYS $0001 for bd sResource 
  168.                 DC.W    TypBoard                    ;ALWAYS $0000 for bd sResource
  169.                 DC.W    DrSwBoard                    ;ALWAYS $0000 for bd sResource
  170.                 DC.W    DrHwBoard                    ;ALWAYS $0000 for bd sResource
  171. _BoardName        DC.L    'OFFICIAL PRODUCT NAME'        ;The name of the Board - should 
  172.                                                     ;be official product name
  173.  
  174.                                                             
  175. ;-------------------------------------------------------------
  176. ;            Primary Init Record (if needed)
  177. ;-------------------------------------------------------------
  178. _sPInitRec        DC.L    _EndsPInitRec-_sPInitRec    ;physical Block Size
  179. ;                INCLUDE    'PrimaryInit.a'                ;Primary Init Code
  180. _EndsPInitRec    EQU        *                            ;End of block
  181.                 STRING     C                            ;Restore to 'c' string type.
  182.  
  183.                                                             
  184. ;-------------------------------------------------------------
  185. ;            Vendor Information record
  186. ;-------------------------------------------------------------
  187.                                                     ;** THE VENDOR INFO ENTRIES
  188.                                                     ;ARE DEFINED BY THE VENDOR, NOT
  189.                                                     ;BY MACDTS **
  190. _VendorInfo        OSLstEntry    VendorId,_VendorId        ;References the Vendor Id. 
  191.                 OSLstEntry    RevLevel,_RevLevel        ;References the Revision Level.
  192.                 OSLstEntry    PartNum,_PartNum        ;References the Part Number.
  193.                 DatLstEntry    endOfList,0                ;End of the list.
  194.  
  195. _VendorId        DC.L    'COMPANY NAME'                 ;The Vendor Id.  Most vendors use
  196.                                                     ;company name
  197. _RevLevel        DC.L    'Release-1.0'                ;The Revision Level
  198. _PartNum        DC.L    '12-3456'                    ;The Part Number
  199.  
  200.                                                             
  201. ;=============================================================
  202. ;            The Functional sResource
  203. ;=============================================================
  204. _sRsrcFun        OSLstEn